Use the Try It Out Functionality

You can send REST Service requests directly from the ebs REST Documentation.

Note: The URL of your REST Services documentation is stored in the Web service host URL setting in Institution Settings.

Use the REST Service documentation to:

You must be authorised for the session before you can run the Try It Out functionality for REST Services with a lock icon in the header.

Note: REST Services without a lock icon do not require authorisation.

To authorise your account:

  1. Click the Authorize button at the top of the screen.

    Authorize button

    The Available authorizations window is displayed.

    Available Authorizations window

  2. Enter your username and password, and then click the top Authorize button.
  3. Click Close.

  4. Open the Authentication REST Service, and then click the Try it out button.

    Try it out button

  5. Click the Execute button.

    Execute button

  6. From the Responses section, copy the token. 

    Token

  7. Click the Authorize button at the top of the page again.

    The Available authorizations window is displayed.

    Authorize Authorizations window

  8. Paste the token into the Value field, and then click Authorize.

    You should then be authorised.

  9. Click Close.

Back to top

You must be authorised before you can run a REST Service with a lock icon in the header. Once authorised, the lock icon is black and closed.

Black lock icon

Note: REST Services without a lock icon do not require authorisation.

To run a REST Service from the documentation:

  1. Navigate to the relevant REST Service, and then click the Try it out button.

    Try it out button

  2. Edit the values as appropriate, remove unwanted fields, and then click Execute.

    Edit Value field and Execute button

    The REST Service is sent. Any errors are displayed in the Response section.

Back to top

The following video provides an example of how REST Services documentation can be used to update learner data:

4.34 REST

Note: Refer to Use Try It Out to Update Learner Details for online documentation describing the steps featured in this video.